ci(pr-validation): replace deprecated changelog gate with commit-lint - #60
ci(pr-validation): replace deprecated changelog gate with commit-lint#60williaby wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Team Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. WalkthroughThe PR validation workflow replaces per-PR changelog enforcement with Conventional-Commits PR-title linting. ChangesCI validation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to PR validation now checks Conventional Commit PR titles instead of requiring changelog edits, reducing changelog merge conflicts while retaining release-time changelog generation. No merge-blocking risk is identified. Suggested labels: Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
The enable-changelog-check gate in python-supplemental-checks.yml was deprecated in ByronWilliamsCPA/.github#288: every PR editing the same CHANGELOG.md produced textual conflicts in the org merge queue (which stacks PRs speculatively), so only one PR could sit in the queue at a time. This repo's pin predates that change, so the gate is still active and still forcing per-PR CHANGELOG.md edits. The changelog is already generated at release by python-semantic-release (release.yml runs python-semantic-release@v10.5.3), so the per-PR edit is redundant. Switch to enable-commit-lint: true so PR titles are validated as Conventional Commits, which is what PSR parses at release, and drop the deprecated enable-changelog-check / changelog-path / changelog-skip-labels inputs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
759b5f6 to
e464139
Compare
|
1 participant
Problem
pr-validation.ymlcallspython-supplemental-checks.ymlwithenable-changelog-check: true, which forces every PR to editCHANGELOG.md.That input was deprecated in ByronWilliamsCPA/.github#288 because, under the org
merge queue (
SQUASH+ALLGREEN, speculative stacking), every PR editing thesame file conflicts textually, so only one PR can sit in the queue at a time.
This repo's workflow is pinned to
987d517d…which predates #288, so thegate is still active and still requiring per-PR
CHANGELOG.mdedits today.Fix
enable-changelog-check/changelog-path/changelog-skip-labels(all deprecated no-ops after #288; the gate defaults off once removed).
enable-commit-lint: trueso PR titles are validated as ConventionalCommits, which is exactly what
python-semantic-releaseparses at release.Why this is safe (no lost changelog)
release.yml:105already runspython-semantic-release@v10.5.3, so thechangelog is generated at release from Conventional Commits. The per-PR edit was
redundant.
enable-commit-lintis supported on the currently pinned SHA (inputexists at that ref), so no
startup_failure.Follow-up (intentionally not bundled here)
The
uses:pin is a SHA labelled# mainrather than a released tag. A separatechange should move it to a
v7.1.x(or reviewedv8.x) tag SHA per the SHA-pinningconvention; that is a workflow-version review of its own and is out of scope for
this input migration.
Generated with Claude Code
Summary by CodeRabbit